docs(kubernetes): add initial reference docs#1243
Merged
TaylorMutch merged 4 commits intomainfrom May 7, 2026
Merged
Conversation
Add a Kubernetes reference section under docs/reference/kubernetes/ covering gateway setup, OIDC and reverse-proxy authentication, cert-manager PKI, and Gateway API external access. Update installation.mdx to link to the new setup page and nest the new folder under the Reference section in index.yml.
TaylorMutch
requested review from
a team,
derekwaynecarr,
maxamillion and
mrunalp
as code owners
|
🌿 Preview your docs: https://nvidia-preview-pr-1243.docs.buildwithfern.com/openshell |
Move docs/reference/kubernetes/ to docs/kubernetes/ so the section appears as a top-level nav entry rather than nested under Reference. Retitle the pages to broader, action-oriented names (Managing Certificates, Ingress, Access Control) and rename the files to match. Update cross-references in setup.mdx and the installation page.
The Reference section was switched to explicit section/contents to host the nested Kubernetes subsection. With Kubernetes promoted to a top-level folder, restore folder-mode auto-detection. Side effect: sandbox-compute-drivers is picked up again, which was silently absent from the explicit list.
Mirror the OpenShift install instructions from PR #1240 into the Kubernetes docs section. Documents the SCC binding for sandbox pods and the chart overrides required by OpenShift's Security Context Constraints (disabled PKI init Job, plaintext TLS, cleared fsGroup and runAsUser).
drew
approved these changes
May 7, 2026
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
2 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.
Summary
Add a Kubernetes reference section under
docs/reference/kubernetes/covering gateway setup, authentication, cert-manager PKI, and Gateway API external access. Cross-link the new setup page from the existing installation page.Related Issue
N/A
Changes
docs/reference/kubernetes/setup.mdx— end-to-end Helm install walkthrough including Agent Sandbox controller prerequisite, chart install from GHCR OCI, port-forward, and CLI registration.docs/reference/kubernetes/authentication.mdx— OIDC user authentication (auth-only and RBAC modes, provider-specificrolesClaimpaths) and reverse-proxy auth termination.docs/reference/kubernetes/cert-manager.mdx— opt-in cert-manager flow as an alternative to the built-inpkiInitJob.docs/reference/kubernetes/gateway-api.mdx— exposing the gateway externally via Envoy Gateway andGRPCRoute, including SSH relay configuration.docs/about/installation.mdx— add a deep link to the new Kubernetes setup page.docs/index.yml— promotereferencefrom a folder to an explicit section so the newkubernetessubsection nests under it.Testing
mise run pre-commitpassesChecklist