https://github.com/cloudfoundry/groot-windows
A Garden image plugin for Windows
https://github.com/cloudfoundry/groot-windows
cloudfoundry garden image-plugin oci oci-image rootfs
Last synced: 10 months ago
JSON representation
A Garden image plugin for Windows
- Host: GitHub
- URL: https://github.com/cloudfoundry/groot-windows
- Owner: cloudfoundry
- License: apache-2.0
- Created: 2018-01-04T23:49:18.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-04-16T03:34:09.000Z (10 months ago)
- Last Synced: 2025-04-16T04:43:16.538Z (10 months ago)
- Topics: cloudfoundry, garden, image-plugin, oci, oci-image, rootfs
- Language: Go
- Homepage:
- Size: 22.2 MB
- Stars: 4
- Watchers: 26
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# groot-windows
A [Garden](https://github.com/cloudfoundry/garden) image plugin for Windows.
## Building
Make sure `GOPATH` is set. Then run:
```
GOOS=windows go build .
```
It generates a `groot-windows.exe` in the current directory.
## Usage
```
groot-windows.exe [global options] command [command options] [arguments...]
```
#### Notes
`groot pull`: Downloads the layers from the image registry if remote, and unpacks each layer into *directories* of the same name/digest located at `/layers`. If `/layers` already contain the same unpacked layers, this is a NOOP.
`groot create`: Runs a `groot pull`, uses the relevant layers to create a virtual Hard disk file inside `/volumes`, mounts it as a Windows Volume path and returns a valid [runtime spec](https://github.com/opencontainers/runtime-spec/blob/master/specs-go/config.go) on stdout.
#### Examples
```
groot-windows.exe --driver-store="c:\ProgramData\groot" create "oci:///C:/hydratorOutput" container1
```
```
groot-windows.exe --driver-store="c:\ProgramData\groot" delete container1
```
Use `groot-windows.exe --help` to show detailed usage.
## Testing
#### Requirements
You must be in a windows environment to run these tests.
To run the entire suite of tests, run `ginkgo -r -race -p .`