Skip to content

index.md

Latest commit

 

History

History
36 lines (25 loc) · 2.5 KB

index.md

File metadata and controls

36 lines (25 loc) · 2.5 KB
Raw

Documentation

Devboxes turns Kubernetes capacity into persistent, SSH-accessible development environments. This documentation covers the supported installation, daily use, operations, security, and contribution paths.

Start here

  • README, product overview, requirements, and the shortest installation path.
  • Golden path, the recommended production-shaped setup and fastest daily workflow.
  • Configuration, every supported Helm value and deployment mode.
  • Credentials, controller authentication and optional workspace accounts.

Use Devboxes

  • CLI reference, commands, global flags, environment variables, output, and SSH forwarding.
  • API reference, authentication, endpoints, request and response contracts, and errors.
  • GPU acceleration, profile design, cluster prerequisites, images, scheduling, security, and diagnosis.
  • Insights, opt-in AI telemetry, aggregate Git activity, privacy boundaries, retention, backup, and purge.
  • The authenticated /docs page in a running controller, an operator-focused guide rendered with installation-specific values.

Operate Devboxes

  • Architecture, components, Kubernetes resources, persistence, scheduling, and trust boundaries.
  • Operations, health, metrics, capacity, backups, upgrades, recovery, and routine maintenance.
  • Troubleshooting, symptom-led diagnosis for scheduling, storage, SSH, authentication, and image failures.
  • Security policy, supported versions, private reporting, deployment controls, and supply-chain policy.
  • Support, public support channels and a redacted diagnostic bundle.

Contribute

  • Development, toolchains, local workflows, test layers, code layout, and release contract.
  • Contributing, review expectations, compatibility rules, and pull request requirements.
  • Code of Conduct, community behavior and enforcement.

Supported scope

Devboxes supports one trusted operator or trusted operator group per installation. The controller is namespaced, each workspace has persistent home storage, each SSH Service uses either LoadBalancer or NodePort, and GPU devices are optional operator-owned profiles. Multi-tenant authorization, untrusted workload isolation, browser terminals, cluster-wide GPU driver installation, and automatic PVC deletion are outside the current scope.