6c9628cdb1
* Rename 'vendor/src' -> 'vendor' * Ignore vendor/ instead of vendor/src/ for lint * Rename 'cmd/client' -> 'cmd/ocic' to make it 'go install'able * Rename 'cmd/server' -> 'cmd/ocid' to make it 'go install'able * Update Makefile to build and install from GOPATH * Update tests to locate ocid/ocic in GOPATH/bin * Search for binaries in GOPATH/bin instead of PATH * Install tools using `go get -u`, so they are updated on each run Signed-off-by: Jonathan Yu <jawnsy@redhat.com>
54 lines
1.2 KiB
Markdown
54 lines
1.2 KiB
Markdown
# Go Wrapper for ZFS #
|
|
|
|
Simple wrappers for ZFS command line tools.
|
|
|
|
[](https://godoc.org/github.com/mistifyio/go-zfs)
|
|
|
|
## Requirements ##
|
|
|
|
You need a working ZFS setup. To use on Ubuntu 14.04, setup ZFS:
|
|
|
|
sudo apt-get install python-software-properties
|
|
sudo apt-add-repository ppa:zfs-native/stable
|
|
sudo apt-get update
|
|
sudo apt-get install ubuntu-zfs libzfs-dev
|
|
|
|
Developed using Go 1.3, but currently there isn't anything 1.3 specific. Don't use Ubuntu packages for Go, use http://golang.org/doc/install
|
|
|
|
Generally you need root privileges to use anything zfs related.
|
|
|
|
## Status ##
|
|
|
|
This has been only been tested on Ubuntu 14.04
|
|
|
|
In the future, we hope to work directly with libzfs.
|
|
|
|
# Hacking #
|
|
|
|
The tests have decent examples for most functions.
|
|
|
|
```go
|
|
//assuming a zpool named test
|
|
//error handling ommitted
|
|
|
|
|
|
f, err := zfs.CreateFilesystem("test/snapshot-test", nil)
|
|
ok(t, err)
|
|
|
|
s, err := f.Snapshot("test", nil)
|
|
ok(t, err)
|
|
|
|
// snapshot is named "test/snapshot-test@test"
|
|
|
|
c, err := s.Clone("test/clone-test", nil)
|
|
|
|
err := c.Destroy()
|
|
err := s.Destroy()
|
|
err := f.Destroy()
|
|
|
|
```
|
|
|
|
# Contributing #
|
|
|
|
See the [contributing guidelines](./CONTRIBUTING.md)
|
|
|