c5e0d68a3d
* API: introduce ability to watch a VM
* Document ?watch=true for GET /vms/{name} in the OpenAPI specification
* WatchVM: ensure that goroutine is terminated on early return with error
* WatchVM: close channels on goroutine exit
* WatchVM: ensure that we wait for the goroutine after additional barriers
* WatchVM: ignore unexpected keys instead of throwing an error
* WatchVM: perform context-aware writes to a bounded channel
* WatchVM: don't forget to close errCh on goroutine exit too
* WatchVM: don't close readyCh in goroutine to avoid ambiguity
* WatchVM: filter out spurious KVs that signify VM deletion
|
||
|---|---|---|
| .github | ||
| api | ||
| cmd/orchard | ||
| docs | ||
| internal | ||
| packaging | ||
| pkg | ||
| rpc | ||
| .cirrus.star | ||
| .cirrus.yml | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| DEVELOPMENT.md | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| buf.gen.yaml | ||
| buf.work.yaml | ||
| go.mod | ||
| go.sum | ||
README.md
Orchard
[!IMPORTANT]
macOS 15 (Sequoia)
The newly introduced "Local Network" permission in macOS Sequoia requires accepting a GUI pop-up on each host machine that runs the Orchard Worker.
To work around this, upgrade your workers to Orchard 0.32.0 or newer and invoke the
orchard worker runasrootwith an additional--usercommand-line argument, which takes a name of your regular, non-privileged user on the host machine.This will cause the Orchard Worker to start a small
orchard localnetworkhelperprocess in the background and then drop the privileges to the specified user.The helper process is privileged and needed to establish network connections on behalf of the Orchard Worker without triggering a GUI pop-up.
This approach is more secure than simply running
orchard worker runasroot, because only a small part of Orchard Worker runs privileged and the only functionality that this part has is establishing new connections.
Orchard is an orchestration system for Tart. Create a cluster of bare-metal Apple Silicon machines and manage dozens of VMs with ease!
Usage
The fastest way to get started with Orchard is to use a local development mode:
brew install cirruslabs/cli/orchard
orchard dev
This will start Orchard Controller and a single Orchard Worker on your local machine.
You can interact with the newly created cluster using the orchard CLI or programmatically, through the built-in REST API server.
Please check out the official documentation for more information and/or feel free to use issues for the remaining questions.