dockerfile

Documentation

Overview

Package dockerfile has utilities that complement Docker's official Dockerfile parser.

Index

• func Env(m []KeyValue) (string, error)
• func FindAll(node *parser.Node, cmd string) []int
• func From(image string) (string, error)
• func InsertInstructions(node *parser.Node, pos int, instructions string) error
• func Label(m []KeyValue) (string, error)
• func Parse(r io.Reader) (*parser.Node, error)
• func Write(node *parser.Node) []byte
• type KeyValue

Functions

func Env

func Env(m []KeyValue) (string, error)

Env builds an ENV Dockerfile instruction from the mapping m. Keys and values are serialized as JSON strings to ensure compatibility with the Dockerfile parser.

func FindAll

func FindAll(node *parser.Node, cmd string) []int

FindAll returns the indices of all children of node such that node.Children[i].Value == cmd. Valid values for cmd are defined in the package github.com/docker/docker/builder/dockerfile/command.

func From

func From(image string) (string, error)

From builds a FROM Dockerfile instruction referring the base image image.

func InsertInstructions

func InsertInstructions(node *parser.Node, pos int, instructions string) error

InsertInstructions inserts instructions starting from the pos-th child of node, moving other children as necessary. The instructions should be valid Dockerfile instructions. InsertInstructions mutates node in-place, and the final state of node is equivalent to what parser.Parse would return if the original Dockerfile represented by node contained the instructions at the specified position pos. If the returned error is non-nil, node is guaranteed to be unchanged.

func Label

func Label(m []KeyValue) (string, error)

Label builds a LABEL Dockerfile instruction from the mapping m. Keys and values are serialized as JSON strings to ensure compatibility with the Dockerfile parser.

func Parse

func Parse(r io.Reader) (*parser.Node, error)

Parse parses the provided stream as a canonical Dockerfile

func Write

func Write(node *parser.Node) []byte

Write takes a Dockerfile AST node, as generated by parser.Parse, and returns a new, equivalent, Dockerfile.

Types

type KeyValue

type KeyValue struct {
	Key   string
	Value string
}

A KeyValue can be used to build ordered lists of key-value pairs.