Build Status GoDoc Go Report Card codecov Open Source Helpers

Function process via docker provider


go get


package main

import (


func main() {
	wait := &sync.WaitGroup{}
	contextDir := flag.String("contextDir", "./", "a string")
	dockerfile := flag.String("dockerfile", "Dockerfile", "a string")
	imageName := flag.String("imageName", "", "a string")
	remoteBuildURI := flag.String("remoteBuildURI", "", "a string")
	volumeSource := flag.String("volumeSource", "", "a string")
	volumeDestination := flag.String("volumeDestination", "", "a string")
	remoteBuild := flag.Bool("remoteBuild", false, "true or false")
	input := flag.String("input", "", "a string")
	parallels := runtime.GOMAXPROCS(-1) // use max allowed CPUs to parallelize
	for i := 0; i < parallels; i++ {
		go run(*contextDir, *dockerfile, *imageName, *remoteBuildURI, *volumeSource, *volumeDestination, wait, *remoteBuild, *input)

func run(contextDir, dockerfile, imageName, remoteBuildURI, volumeSource, volumeDestination string, wait *sync.WaitGroup, remote bool, input string) {
	buildOpts := &provision.BuildOptions{
		ContextDir: contextDir,
		Dockerfile: dockerfile,
		ImageName:  imageName,
		RemoteURI:  remoteBuildURI,
		StdIN:      input,
	containerOpts := &provision.ContainerOptions{}
	if volumeSource != "" {
		if volumeDestination == "" {
			volumeDestination = volumeSource
		containerOpts.Volumes = []string{fmt.Sprintf("%s:%s", volumeSource, volumeDestination)}
	if remote {
		key := os.Getenv("DIGITALOCEAN_API_KEY")
		if key == "" {
			log.Fatalln("You must provide an api key for digital ocean")
		do, err := digitalocean.New(key)
		if err != nil {
		buildOpts.Iaas = do

	defer wait.Done()
	stdout, stderr, err := gofn.Run(context.Background(), buildOpts, containerOpts)
	if err != nil {
	fmt.Println("Stderr: ", stderr)
	fmt.Println("Stdout: ", stdout)

Run Example

cd examples

go run main.go -contextDir=testDocker -imageName=python -dockerfile=Dockerfile

# or using volume
go run main.go -contextDir=testDocker -imageName=python -dockerfile=Dockerfile -volumeSource=/tmp -volumeDestination=/tmp

# or using remote Dockerfile
go run main.go -remoteBuildURI= -imageName="pythonexample"

# you can also send a string that will be written to the stdin of the container
go run main.go -contextDir=testDocker -imageName=python -dockerfile=Dockerfile -input "input string"

# or run in digital ocean
export DIGITALOCEAN_API_KEY="paste your key here"
go run main.go -contextDir=testDocker -imageName=python -dockerfile=Dockerfile -remoteBuild=true

You can also compile with go build or build and install with go install command then run it as a native executable.

Example Parameters

  • -contextDir is the root directory where the Dockerfile, scripts, and other container dependencies are, by default current directory "./".

  • -imageName is the name of the image you want to start, if it does not exist it will be automatically generated and if it exists the system will just start the container.

  • -dockerFile is the name of the file containing the container settings, by default Dockerfile

  • -volumeSource is the directory that will be mounted as a data volume. By default is empty string indicating his not used.

  • -volumeDestination is the path mounted inside the container. By default is empty string indicating his not used but if only omitted, volumeSource is used.

  • -remoteBuildURI is remote URI containing the Dockerfile to build.By default is empty. More details on docker api docs

  • remoteBuild is a boolean that indicates if have to run localally or in a machine in digital ocean Don't forget to export your api key.

  • -input is a string that will be written to the stdin of the container

  • -h Shows the list of parameters

gofn generates the images with "gofn/" as a prefix.

Expand ▾ Collapse ▴




This section is empty.


This section is empty.


func Attach

func Attach(ctx context.Context, client *docker.Client, container *docker.Container, stdin io.Reader, stdout io.Writer, stderr io.Writer) (docker.CloseWaiter, error)

    Attach allow to connect into a running container and interact using stdout, stderr and stdin

    func DestroyContainer

    func DestroyContainer(ctx context.Context, client *docker.Client, container *docker.Container) error

      DestroyContainer remove by force a container

      func PrepareContainer

      func PrepareContainer(ctx context.Context, client *docker.Client, buildOpts *provision.BuildOptions, containerOpts *provision.ContainerOptions) (container *docker.Container, err error)

        PrepareContainer build an image if necessary and run the container

        func ProvideMachine

        func ProvideMachine(ctx context.Context, service iaas.Iaas) (client *docker.Client, machine *iaas.Machine, err error)

          ProvideMachine provisioning a machine in the cloud

          func Run

          func Run(ctx context.Context, buildOpts *provision.BuildOptions, containerOpts *provision.ContainerOptions) (stdout string, stderr string, err error)

            Run runs the designed image

            func RunWait

            func RunWait(ctx context.Context, client *docker.Client, container *docker.Container) (errors chan error, err error)

              RunWait runs the conainer returning channels to control your status


              This section is empty.

              Source Files