Skip to content

docs: add k3s use case guide#311

Draft
OndrejDrapalik wants to merge 2 commits into
mainfrom
docs/k3s-template
Draft

docs: add k3s use case guide#311
OndrejDrapalik wants to merge 2 commits into
mainfrom
docs/k3s-template

Conversation

@OndrejDrapalik

@OndrejDrapalik OndrejDrapalik commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add a new /docs/use-cases/k3s guide for the official e2b/k3s template
  • document CLI, TypeScript, and Python workflows using the standard Sandbox API and commands.run
  • show a browser-visible Kubernetes deployment using kubectl port-forward and getHost
  • explain cluster-per-task production use cases, preview status, startup readiness handling, and single-node limitations

Dependencies

Validation

  • mintlify validate
  • mintlify broken-links
  • TypeScript and Python snippets parsed successfully
  • rebuilt the exact current starter-template PR head (9121d260) under a temporary private tag
  • upstream E2E passed: KUBECONFIG propagation, Ready node, DNS, and ClusterIP traffic
  • docs browser-preview flow against that build returned HTTP 200

The docs explicitly poll for the Node and CoreDNS objects before waiting for their Ready conditions because PR #49 currently gates sandbox creation on Kubernetes API readiness only.

@linear-code

linear-code Bot commented Jul 24, 2026

Copy link
Copy Markdown

INT-105

@mintlify

mintlify Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
e2b 🟢 Ready View Preview Jul 24, 2026, 3:25 PM

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant