OpenFrame Documentation
Deployment guides, the CLI reference, architecture and admin guides for OpenFrame
OpenFrame is on your phone now! · iOS and Android apps are live. Get alerts and handle tickets on the go!
Deployment guides, the CLI reference, architecture and admin guides for OpenFrame
Welcome to the documentation for OpenFrame CLI.
OpenFrame CLI is the command-line tool for provisioning Kubernetes clusters (local k3d, or cloud GKE/EKS via Terraform) and deploying the OpenFrame platform onto them.
openframeHow-to guides:
openframe command to provision a new Kubernetes clustergo module github.com/flamingo-stack/openframe-cligoreleaser releaseReference docs are in ./reference/architecture/:
Visual documentation - View Mermaid diagrams in: ./diagrams/architecture/
./diagrams/architecture/app-status-aggregation.mmd - App status aggregation flow./diagrams/architecture/architecture-diagram.mmd - Overall architecture diagram./diagrams/architecture/bootstrap-sequence.mmd - Bootstrap sequence diagram./diagrams/architecture/dependency-diagram.mmd - Dependency diagramThe OpenFrame Main code Repository is maintained in a separate repository:
Note: CLI tools (the main OpenFrame platform source) are NOT located in this repository. Always refer to the external repository above for the platform's own installation and usage details. This repository, flamingo-stack/openframe-cli, publishes the openframe command-line tool itself (Go module github.com/flamingo-stack/openframe-cli) that provisions clusters and deploys that platform.
Documentation coming soon.
Documentation generated by 🦩 Flamingo Code Documentation