https://github.com/cirruslabs/tart-buildkite-plugin
Run Buildkite steps inside Tart Virtual Machines
https://github.com/cirruslabs/tart-buildkite-plugin
buildkite-plugin
Last synced: 5 months ago
JSON representation
Run Buildkite steps inside Tart Virtual Machines
- Host: GitHub
- URL: https://github.com/cirruslabs/tart-buildkite-plugin
- Owner: cirruslabs
- Created: 2023-11-29T13:37:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-01T15:29:34.000Z (almost 2 years ago)
- Last Synced: 2025-04-09T14:04:32.686Z (6 months ago)
- Topics: buildkite-plugin
- Language: Shell
- Homepage:
- Size: 3.91 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tart Buildkite Plugin
A [Buildkite plugin](https://buildkite.com/docs/plugins) for running pipeline steps in [Tart](https://github.com/cirruslabs/tart) Virtual Machines.
## Prequisites
This plugin assumes that your pipeline is running on an Apple Silicon host with [Tart](https://tart.run/) installed:
```
brew install cirruslabs/cli/tart
```
You'll also need to install the `sshpass` utility program, so that the plugin will be able to connect to the Tart VMs using password-based authentication:
```
brew install cirruslabs/cli/sshpass
```
## Example
Add the following to your `pipeline.yml`:
```yml
steps:
- command: uname -a
plugins:
- cirruslabs/tart#v0.2.0:
image: ghcr.io/cirruslabs/macos-sonoma-base:latest
```
## Configuration
### `image` (`string`, required)
Tart VM image to use.
### `ssh_username` (`string`, optional)
Username to use when connecting to the VM via SSH.
Defaults to `admin`.
### `ssh_password` (`string`, optional)
Password to use when connecting to the VM via SSH.
Defaults to `admin`.
### `headless` (`boolean`, optional)
Whether to run the VM in headless mode (`true`) or with GUI (`false`).
Defaults to `true`.
### `always_pull` (`boolean`, optional)
Whether to always pull the VM using `tart pull` before `tart clone` (`true`) or not (`false`).
Defaults to `true`.
### `softnet` (`boolean`, optional)
Whether to enable [software networking isolation for Tart](https://github.com/cirruslabs/softnet) (`true`) or not (`false`).
Defaults to `false`.