Package imagestore is a mistify subagent that manages guest disks and zfs pools, exposed via JSON-RPC over HTTP.
/_mistify_RPC_
* GET - Run a specified method
/snapshots/download
* GET - Streaming download a zfs snapshot. Query with SnapshotRequest.
{
"method": "RPC_METHOD",
"params": [
DATA_STRUCT
],
"id": 0
}
Where RPC_METHOD is the desired method and DATA_STRUCTURE is one of the request structs defined in http://godoc.org/github.com/mistifyio/mistify-agent/rpc .
{
"result": {
KEY: RESPONSE_STRUCT
},
"error": null,
"id": 0
}
Where KEY is a string (e.g. "snapshot") and DATA is one of the response structs defined in http://godoc.org/github.com/mistifyio/mistify-agent/rpc .
ListImages
GetImage
RequestImage
DeleteImage
CloneImage
ListSnapshot
GetSnapshot
CreateSnapshot
DeleteSnapshot
RollbackSnapshot
VerifyDisks
CreateGuestDisks
DeleteGuestDisks
See the godocs and function signatures for each method's purpose and expected request/response structs.
const (
// EAGAIN is a shortcut to syscall.EAGAIN
EAGAIN = syscall.EAGAIN
// EEXIST is a shortcut to syscall.EEXIST
EEXIST = syscall.EEXIST
// ENOSPC is a shortcut to syscall.ENOSPC
ENOSPC = syscall.ENOSPC
// EINVAL is a shortcut to syscall.EINVAL
EINVAL = syscall.EINVAL
// DBTABLE is the tablename for images
DBTABLE = "mistify-agent-image"
)var (
// ErrNotFound is an error when resource not being found
ErrNotFound = errors.New("not found")
// ErrNotVolume is an error when the resouce is expected to be a volume and isn't
ErrNotVolume = errors.New("not a volume")
// ErrNotSnapshot is an error when the resouce is expected to be a snapshot and isn't
ErrNotSnapshot = errors.New("not a snapshot")
// ErrNotValid is an error when the resouce is expected to be a dataset and isn't
ErrNotValid = errors.New("not a valid dataset")
)type Config struct {
ImageServer string // if we get a relative url, we prepend this
NumFetchers uint // workers to use for fetching images
MaxPending uint // maximum number of queued fetch image
Zpool string
}Config contains configuration for the ImageStore
type ErrorHTTPCode struct {
Expected int
Code int
Source string
}ErrorHTTPCode should be used for errors resulting from an http response code not matching the expected code
func (e ErrorHTTPCode) Error() stringError returns a string error message
type ImageStore struct {
DB *kvite.DB
}ImageStore manages disk images
func Create(config Config) (*ImageStore, error)Create creates an image store with the given config
func (store *ImageStore) CloneImage(r *http.Request, request *rpc.ImageRequest, response *rpc.VolumeResponse) errorCloneImage clones a disk image
func (store *ImageStore) CreateGuestDisks(r *http.Request, request *rpc.GuestRequest, response *rpc.GuestResponse) errorCreateGuestDisks creates guest disks
func (store *ImageStore) CreateSnapshot(r *http.Request, request *rpc.SnapshotRequest, response *rpc.SnapshotResponse) errorCreateSnapshot creates a snapshot of a zfs dataset.
Request params:
id string : Req : ID of the zfs dataset to snapshot
dest string : Req : Name of the snapshot
recursive bool : : Recursively create snapshots of descendents
func (store *ImageStore) CreateVolume(r *http.Request, request *rpc.VolumeRequest, response *rpc.VolumeResponse) errorCreateVolume creates a zfs volume
func (store *ImageStore) DeleteDataset(r *http.Request, request *rpc.VolumeRequest, response *rpc.VolumeResponse) errorDeleteDataset deletes a zfs dataset
func (store *ImageStore) DeleteGuestsDisks(r *http.Request, request *rpc.GuestRequest, response *rpc.GuestResponse) errorDeleteGuestsDisks removes guests disks. It actually removes the entire guest filesystem.
func (store *ImageStore) DeleteImage(r *http.Request, request *rpc.ImageRequest, response *rpc.ImageResponse) errorDeleteImage deletes a disk image
func (store *ImageStore) DeleteSnapshot(r *http.Request, request *rpc.SnapshotRequest, response *rpc.SnapshotResponse) errorDeleteSnapshot deletes a snapshot.
Request params:
id string : Req : Full name of the snapshot
recursive bool : : Recursively delete descendent snapshots
func (store *ImageStore) Destroy() errorDestroy destroys a store
func (store *ImageStore) DownloadSnapshot(w http.ResponseWriter, r *http.Request)DownloadSnapshot downloads a zfs snapshot as a stream of data
Request params:
id string : Req : Full name of the snapshot
func (store *ImageStore) GetImage(r *http.Request, request *rpc.ImageRequest, response *rpc.ImageResponse) errorGetImage gets a disk image
func (store *ImageStore) GetSnapshot(r *http.Request, request *rpc.SnapshotRequest, response *rpc.SnapshotResponse) errorGetSnapshot retrieves information about a snapshot.
Request params:
id string : Req : Full name of the snapshot
func (store *ImageStore) GetVolume(r *http.Request, request *rpc.VolumeRequest, response *rpc.VolumeResponse) errorGetVolume gets information about a zfs volume
func (store *ImageStore) ListImages(r *http.Request, request *rpc.ImageRequest, response *rpc.ImageResponse) errorListImages lists the disk images
func (store *ImageStore) ListSnapshots(r *http.Request, request *rpc.SnapshotRequest, response *rpc.SnapshotResponse) errorListSnapshots retrieves a list of all snapshots for a dataset.
Request params:
id string : : Dataset to list snapshots for
func (store *ImageStore) ListVolumes(r *http.Request, request *rpc.VolumeRequest, response *rpc.VolumeResponse) errorListVolumes lists the zfs volumes
func (store *ImageStore) RequestClone(name, dest string) (*zfs.Dataset, error)RequestClone clones a dataset
func (store *ImageStore) RequestImage(r *http.Request, request *rpc.ImageRequest, response *rpc.ImageResponse) errorRequestImage fetches an image
func (store *ImageStore) RollbackSnapshot(r *http.Request, request *rpc.SnapshotRequest, response *rpc.SnapshotResponse) errorRollbackSnapshot performs a zfs snapshot rollback
func (store *ImageStore) Run()Run starts processing for jobs
func (store *ImageStore) RunHTTP(port uint) errorRunHTTP creates and runs the http server
func (store *ImageStore) SpaceAvailible() (uint64, error)SpaceAvailible returns the available disk space ensure we are not "over-committing" on disk
func (store *ImageStore) VerifyDisks(r *http.Request, request *rpc.GuestRequest, response *rpc.GuestResponse) errorVerifyDisks verifys a guests's disk configuration before vm creation used for pre-flight check for vm creation we should also check to see if we have enough disk space for it. perhaps in a seperate call?
-- Generated with godocdown