dockercontroller

Documentation

Index

• Constants
• type BuildMetrics
  • func NewBuildMetrics(p metrics.Provider) *BuildMetrics
• type DockerVM
  • func (vm *DockerVM) GetVMName(ccid ccintf.CCID) string
  • func (vm *DockerVM) GetVMNameForDocker(ccid ccintf.CCID) (string, error)
  • func (vm *DockerVM) HealthCheck(ctx context.Context) error
  • func (vm *DockerVM) Start(ccid ccintf.CCID, args, env []string, filesToUpload map[string][]byte, ...) error
  • func (vm *DockerVM) Stop(ccid ccintf.CCID, timeout uint, dontkill bool, dontremove bool) error
  • func (vm *DockerVM) Wait(ccid ccintf.CCID) (int, error)
• type Provider
  • func (p *Provider) NewVM() container.VM

Constants

const ContainerType = "DOCKER"

ContainerType is the string which the docker container type is registered with the container.VMController

Types

type BuildMetrics

type BuildMetrics struct {
	ChaincodeImageBuildDuration metrics.Histogram
}

func NewBuildMetrics

func NewBuildMetrics(p metrics.Provider) *BuildMetrics

type DockerVM

type DockerVM struct {
	PeerID        string
	NetworkID     string
	BuildMetrics  *BuildMetrics
	HostConfig    *docker.HostConfig
	Client        dockerClient
	AttachStdOut  bool
	ChaincodePull bool
}

DockerVM is a vm. It is identified by an image id

func (*DockerVM) GetVMName

func (vm *DockerVM) GetVMName(ccid ccintf.CCID) string

GetVMName generates the VM name from peer information. It accepts a format function parameter to allow different formatting based on the desired use of the name.

func (*DockerVM) GetVMNameForDocker

func (vm *DockerVM) GetVMNameForDocker(ccid ccintf.CCID) (string, error)

GetVMNameForDocker formats the docker image from peer information. This is needed to keep image (repository) names unique in a single host, multi-peer environment (such as a development environment). It computes the hash for the supplied image name and then appends it to the lowercase image name to ensure uniqueness.

func (*DockerVM) HealthCheck

func (vm *DockerVM) HealthCheck(ctx context.Context) error

HealthCheck checks if the DockerVM is able to communicate with the Docker daemon.

func (*DockerVM) Start

func (vm *DockerVM) Start(ccid ccintf.CCID, args, env []string, filesToUpload map[string][]byte, builder container.Builder) error

Start starts a container using a previously created docker image

func (*DockerVM) Stop

func (vm *DockerVM) Stop(ccid ccintf.CCID, timeout uint, dontkill bool, dontremove bool) error

Stop stops a running chaincode

func (*DockerVM) Wait

func (vm *DockerVM) Wait(ccid ccintf.CCID) (int, error)

Wait blocks until the container stops and returns the exit code of the container.

type Provider

type Provider struct {
	PeerID        string
	NetworkID     string
	BuildMetrics  *BuildMetrics
	HostConfig    *docker.HostConfig
	Client        dockerClient
	AttachStdOut  bool
	ChaincodePull bool
}

Provider implements container.VMProvider

func (*Provider) NewVM

func (p *Provider) NewVM() container.VM

NewVM creates a new DockerVM instance