container

Documentation

Index

• Constants
• func VMCProcess(ctxt context.Context, vmtype string, req VMCReqIntf) (interface{}, error)
• type CreateImageReq
• type DestroyImageReq
• type StartImageReq
• type StopImageReq
• type VM
  • func NewVM() (*VM, error)
  • func (vm *VM) BuildChaincodeContainer(spec *pb.ChaincodeSpec, chaincodePkgBytes []byte) error
  • func (vm *VM) ListImages(context context.Context) error
• type VMCReqIntf
• type VMCResp
• type VMController

Constants

const (
	DOCKER = "Docker"
	SYSTEM = "System"
)

constants for supported containers

Functions

func VMCProcess

func VMCProcess(ctxt context.Context, vmtype string, req VMCReqIntf) (interface{}, error)

VMCProcess should be used as follows

. construct a context
. construct req of the right type (e.g., CreateImageReq)
. call it in a go routine
. process response in the go routing

context can be cancelled. VMCProcess will try to cancel calling functions if it can For instance docker clients api's such as BuildImage are not cancelable. In all cases VMCProcess will wait for the called go routine to return

Types

type CreateImageReq

type CreateImageReq struct {
	ccintf.CCID
	Reader       io.Reader
	AttachStdin  bool
	AttachStdout bool
	Args         []string
	Env          []string
}

CreateImageReq - properties for creating an container image

type DestroyImageReq

type DestroyImageReq struct {
	ccintf.CCID
	Timeout uint
	Force   bool
	NoPrune bool
}

DestroyImageReq - properties for stopping a container.

type StartImageReq

type StartImageReq struct {
	ccintf.CCID
	Reader       io.Reader
	Args         []string
	Env          []string
	AttachStdin  bool
	AttachStdout bool
}

StartImageReq - properties for starting a container.

type StopImageReq

type StopImageReq struct {
	ccintf.CCID
	Timeout uint
	//by default we will kill the container after stopping
	Dontkill bool
	//by default we will remove the container after killing
	Dontremove bool
}

StopImageReq - properties for stopping a container.

type VM

type VM struct {
	Client *docker.Client
}

VM implemenation of VM management functionality.

func NewVM

func NewVM() (*VM, error)

NewVM creates a new VM instance.

func (*VM) BuildChaincodeContainer

func (vm *VM) BuildChaincodeContainer(spec *pb.ChaincodeSpec, chaincodePkgBytes []byte) error

BuildChaincodeContainer builds the container for the supplied chaincode specification

func (*VM) ListImages

func (vm *VM) ListImages(context context.Context) error

ListImages list the images available

type VMCReqIntf

type VMCReqIntf interface {
	// contains filtered or unexported methods
}

VMCReqIntf - all requests should implement this interface. The context should be passed and tested at each layer till we stop note that we'd stop on the first method on the stack that does not take context

type VMCResp

type VMCResp struct {
	Err  error
	Resp interface{}
}

VMCResp - response from requests. resp field is a anon interface. It can hold any response. err should be tested first

type VMController

type VMController struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

VMController - manages VMs

. abstract construction of different types of VMs (we only care about Docker for now)
. manage lifecycle of VM (start with build, start, stop ...
  eventually probably need fine grained management)