gofn

KO | EN

gitlite — search

#python #react #ai #typescript #llm #android #linux #nodejs #awesome #kubernetes #vue #pytorch #openai #open-source

(★ 138)

Function process via docker provider (serverless minimalist)

File Explorer

Download Latest Version (.zip)

- - logo.png
- - main.go
  - README.md
- - main.go
- - main.go
  - README.md
- - main.go
- - main.go
  - README.md
- - main.go
- - main.go
- - amazonec2.go
  - amazonec2_test.go
- - digitalocean.go
  - digitalocean_test.go
- - google.go
  - google_test.go
- - tcp.go
  - tcp_test.go
- iaas.go
- - Dockerfile
  - main.py
- docker.go
- docker_integration_test.go
- docker_integration_unix_test.go
- docker_integration_windows_test.go
- docker_test.go
- docker_unix.go
- docker_unix_test.go
- docker_windows.go
- docker_windows_test.go
.codeclimate.yml
.gitignore
.travis.yml
gofn.go
gofn_test.go
LICENSE
Makefile
README.md
test.sh

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![gofn](https://raw.githubusercontent.com/gofn/gofn/master/docs/assets/logo.png)

[![Build Status](https://travis-ci.org/gofn/gofn.svg?branch=master)](https://travis-ci.org/gofn/gofn)
[![GoDoc](https://godoc.org/github.com/gofn/gofn?status.png)](https://godoc.org/github.com/gofn/gofn)
[![Go Report Card](https://goreportcard.com/badge/github.com/gofn/gofn)](https://goreportcard.com/report/github.com/gofn/gofn)
[![codecov](https://codecov.io/gh/gofn/gofn/branch/master/graph/badge.svg)](https://codecov.io/gh/gofn/gofn)
[![Join the chat at https://gitter.im/gofn/gofn](https://badges.gitter.im/gofn/gofn.svg)](https://gitter.im/gofn/gofn?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Open Source Helpers](https://www.codetriage.com/nuveo/gofn/badges/users.svg)](https://www.codetriage.com/nuveo/gofn)

Function process via docker provider

## Install

```bash
go get github.com/gofn/gofn
```

## Example

```go
package main

import (
	"context"
	"flag"
	"fmt"
	"log"
	"os"
	"runtime"
	"sync"

"github.com/gofn/gofn"
	"github.com/gofn/gofn/iaas/digitalocean"
	"github.com/gofn/gofn/provision"
)

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")
	flag.Parse()
	parallels := runtime.GOMAXPROCS(-1) // use max allowed CPUs to parallelize
	wait.Add(parallels)
	for i := 0; i < parallels; i++ {
		go run(*contextDir, *dockerfile, *imageName, *remoteBuildURI, *volumeSource, *volumeDestination, wait, *remoteBuild, *input)
	}
	wait.Wait()
}

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 {
			log.Println(err)
		}
		buildOpts.Iaas = do
	}

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

### Run Example

```bash
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=https://github.com/gofn/dockerfile-python-example.git -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](https://docs.docker.com/engine/reference/commandline/build/#/git-repositories)

* 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.

gofn

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

gofn

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README