docker

Documentation

Overview

Parse a dockerfile into a high-level representation using the official go parser

Index

• Constants
• func AirflowCommand(id string, airflowCommand string) string
• func AllCmds() []string
• func Exec(args ...string) error
• func ExecLogin(serverAddress, username, token string) error
• func ExecPush(serverAddress, token, image string) error
• func GetImageTagFromParsedFile(cmds []Command) (baseImage, tag string)
• type Command
  • func ParseFile(filename string) ([]Command, error)
  • func ParseReader(file io.Reader) ([]Command, error)
• type IOError
  • func (e IOError) Error() string
• type ParseError
  • func (e ParseError) Error() string

Constants

const (
	// Docker is the docker command.
	Docker = "docker"
)

Functions

func AirflowCommand

func AirflowCommand(id string, airflowCommand string) string

AirflowCommand is the main method of interaction with Airflow

func AllCmds

func AllCmds() []string

List all legal cmds in a dockerfile

func Exec

func Exec(args ...string) error

Exec executes a docker command

func ExecLogin

func ExecLogin(serverAddress, username, token string) error

ExecLogin executes a docker login similar to docker login command

func ExecPush

func ExecPush(serverAddress, token, image string) error

ExecPush does push image to registry using native docker client, instead of using `docker push` in bash

func GetImageTagFromParsedFile

func GetImageTagFromParsedFile(cmds []Command) (baseImage, tag string)

Parse tag from parsed dockerfile: e.g. FROM ubuntu:xenial returns "ubuntu", "xenial"

Types

type Command

type Command struct {
	Cmd       string   // lower cased command name (ex: `from`)
	SubCmd    string   // for ONBUILD only this holds the sub-command
	Json      bool     // whether the value is written in json form
	Original  string   // The original source line
	StartLine int      // The original source line number which starts this command
	EndLine   int      // The original source line number which ends this command
	Flags     []string // Any flags such as `--from=...` for `COPY`.
	Value     []string // The contents of the command (ex: `ubuntu:xenial`)
}

Represents a single line (layer) in a Dockerfile. For example `FROM ubuntu:xenial`

func ParseFile

func ParseFile(filename string) ([]Command, error)

Parse a Dockerfile from a filename. An IOError or ParseError may occur.

func ParseReader

func ParseReader(file io.Reader) ([]Command, error)

Parse a Dockerfile from a reader. A ParseError may occur.

type IOError

type IOError struct {
	Msg string
}

A failure in opening a file for reading.

func (IOError) Error

func (e IOError) Error() string

type ParseError

type ParseError struct {
	Msg string
}

A failure in parsing the file as a dockerfile.

func (ParseError) Error

func (e ParseError) Error() string