fugu

README

What is fugu?

• fugu is a convenience wrapper around docker commands
• fugu loads config from a fugu.yml file and merges these arguments with command line flags.

Example

# fugu.yml (maybe stored next to Dockerfile)
image:  ubuntu
name:   my-ubuntu
publish:
  - 8080:80

$ fugu run --detach # runs ...
docker run --detach --name=my-ubuntu --publish=8080:80 ubuntu

Fugu commands include: build, run, exec, destroy, push, pull, images.

All commands and their usage and example fugu.yml files.

Installation

# Mac OS X
curl -L https://github.com/mattes/fugu/releases/download/v1.1.1/fugu.v1.1.1.darwin.x86_64.tar.gz | tar xvz
mv fugu.v1.1.1.darwin.x86_64 /usr/local/bin/fugu
chmod +x /usr/local/bin/fugu

# Linux
curl -L https://github.com/mattes/fugu/releases/download/v1.1.1/fugu.v1.1.1.linux.x86_64.tar.gz | tar xvz
mv fugu.v1.1.1.linux.x86_64 /usr/local/bin/fugu
chmod +x /usr/local/bin/fugu

How is this different from docker-compose/ fig?

While docker-compose (originated from fig) focuses on the definition and orchestration of complex application environments, fugu focuses on one single docker container/ docker image.

Changelog

Find the changelog and breaking changes here: https://github.com/mattes/fugu/releases

---

Fugu is built on top of go-collect.

Credits

Thanks to Thiago Lifter for his nice fugu fish logo.

Documentation

Index

• Variables
• func DockerExec(cmd string, printCmd bool)
• type RegistryDockerImage
  • func ListImages(registry, user, password string) ([]RegistryDockerImage, error)
• type RegistryDockerImages
  • func (a RegistryDockerImages) Len() int
  • func (a RegistryDockerImages) Less(i, j int) bool
  • func (a RegistryDockerImages) Swap(i, j int)

Variables

var (
	ErrTooManyArgs   = errors.New("too many arguments given")
	ErrMissingImage  = errors.New("image option is missing")
	ErrMissingName   = errors.New("name option is missing")
	ErrUnknownLabel  = errors.New("unknown label")
	ErrTagGitBranch  = errors.New("tag-git-branch failed")
	ErrMissingFlag   = errors.New("missing required flag")
	ErrNoCredentials = errors.New("missing required credentials")
)

var Commands = make(map[string]func(c *collect.Collector, p *data.Data, args []string) (err error))

Commands have more freedom and usually print to stdout/stderr directly

var DockerCommands = make(map[string]func(c *collect.Collector, p *data.Data, args []string) (str string, err error))

DockerCommands return string that is always run

var DockerFlags = make(map[string]*flags.Flags)

var FuguFlags = make(map[string]*flags.Flags)

Functions

func DockerExec

func DockerExec(cmd string, printCmd bool)

DockerExec runs a docker command

Types

type RegistryDockerImage

type RegistryDockerImage struct {
	Name string
	Tags []string
}

func ListImages

func ListImages(registry, user, password string) ([]RegistryDockerImage, error)

type RegistryDockerImages

type RegistryDockerImages []RegistryDockerImage

func (RegistryDockerImages) Len

func (a RegistryDockerImages) Len() int

func (RegistryDockerImages) Less

func (a RegistryDockerImages) Less(i, j int) bool

func (RegistryDockerImages) Swap

func (a RegistryDockerImages) Swap(i, j int)