Skip to content

docs: update gateway deployment architecture#1108

Draft
drew wants to merge 1 commit intomainfrom
remove-k3s
Draft

docs: update gateway deployment architecture#1108
drew wants to merge 1 commit intomainfrom
remove-k3s

Conversation

@drew
Copy link
Copy Markdown
Collaborator

@drew drew commented May 1, 2026

Draft: this PR is not ready for review.

Summary

Rewrite the OpenShell documentation and architecture references away from the embedded k3s cluster image model and toward a gateway plus compute-platform model.

Related Issue

None.

Changes

  • Reframed published docs around registered gateway endpoints backed by Docker, Podman, Kubernetes, or MicroVM compute platforms.
  • Kept the Helm chart as the Kubernetes deployment path while removing cluster image/bootstrap publishing language from docs.
  • Reworked architecture docs for gateway deployment, packaging, security, system diagrams, sandbox image delivery, and inference/gateway wording.
  • Updated agent and contributor docs, including troubleshooting skills, to diagnose gateway deployment/runtime issues instead of k3s cluster bootstrap.

Testing

  • mise run docs
  • helm lint deploy/helm/openshell
  • git diff --check
  • mise run pre-commit
  • Unit tests added/updated (docs only)
  • E2E tests added/updated (docs only)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated

Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 1, 2026

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

Copy link
Copy Markdown

@cgwalters cgwalters left a comment

Choose a reason for hiding this comment

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

Only skimmed, just approving the direction! Will be a big improvement.

- The `openshell` CLI must be available for endpoint checks.
- Know the active gateway name and endpoint, or be able to inspect local gateway metadata.
- Know the compute platform: Docker, Podman, Kubernetes, or VM.
- For Kubernetes: `kubectl` must target the cluster that hosts OpenShell and Helm 3 must be available.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- For Kubernetes: `kubectl` must target the cluster that hosts OpenShell and Helm 3 must be available.
- For Kubernetes: `kubectl` must target the cluster that hosts OpenShell and Helm version 3 or later must be available.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants