Knowledge Hub
Comprehensive guides and references for the OpenFrame platform
Comprehensive guides and references for the OpenFrame platform
A full local OpenFrame platform is resource-intensive. Recommended host:
| Resource | Recommended |
|---|---|
| RAM | 24 GB |
| CPU | 6 cores |
| Disk | 50 GB free |
| Architecture | x86_64 or ARM64 |
| OS | Notes |
|---|---|
| Linux | Ubuntu 20.04+, RHEL/CentOS 8+ |
| macOS | 11 (Big Sur) or later |
| Windows | Windows 10/11 with WSL2 |
On Windows, openframe auto-forwards the whole invocation into WSL2 and runs as a Linux binary — just run openframe ... normally. There's no need to wsl -d Ubuntu first.
Docker is the only tool you must install and run yourself. It provides the container runtime that k3d clusters run on. See the Docker install guide.
The CLI installs everything else automatically:
~/.openframe/binmkcert -install modifies the OS trust store (and may prompt for sudo), so it is skipped in non-interactive mode.Verify Docker is running:
docker ps
Report on all prerequisites:
openframe prerequisites check
Install anything that's missing:
openframe prerequisites install
openframe bootstrap also runs these checks and installs missing tools before creating a cluster.
Outbound internet access is needed to pull container images, download Helm charts, clone the platform repository, and fetch pinned tool binaries.
Need help? OpenMSP Slack