dockerfile

Documentation

Overview

Package dockerfile provides functionality to parse a Dockerfile.

Index

• type Dockerfile
  • func New(fs afero.Fs, path string) *Dockerfile
  • func (df *Dockerfile) GetExposedPorts() ([]Port, error)
  • func (df *Dockerfile) GetHealthCheck() (*HealthCheck, error)
• type ErrInvalidPort
  • func (e ErrInvalidPort) Error() string
• type ErrNoExpose
  • func (e ErrNoExpose) Error() string
• type HealthCheck
• type Port
  • func (p *Port) String() string

Types

type Dockerfile

type Dockerfile struct {
	// contains filtered or unexported fields
}

Dockerfile represents a parsed Dockerfile.

func New

func New(fs afero.Fs, path string) *Dockerfile

New returns an empty Dockerfile.

func (*Dockerfile) GetExposedPorts

func (df *Dockerfile) GetExposedPorts() ([]Port, error)

GetExposedPorts returns a uint16 slice of exposed ports found in the Dockerfile.

func (*Dockerfile) GetHealthCheck

func (df *Dockerfile) GetHealthCheck() (*HealthCheck, error)

GetHealthCheck parses the HEALTHCHECK instruction from the Dockerfile and returns it. If the HEALTHCHECK is NONE or there is no instruction, returns nil.

type ErrInvalidPort

type ErrInvalidPort struct {
	Match string
}

ErrInvalidPort means that while there was a port provided, it was out of bounds or unparseable

func (ErrInvalidPort) Error

func (e ErrInvalidPort) Error() string

type ErrNoExpose

type ErrNoExpose struct {
	Dockerfile string
}

ErrNoExpose means there were no documented EXPOSE statements in the given dockerfile.

func (ErrNoExpose) Error

func (e ErrNoExpose) Error() string

type HealthCheck

type HealthCheck struct {
	Interval    time.Duration
	Timeout     time.Duration
	StartPeriod time.Duration
	Retries     int
	Cmd         []string
}

HealthCheck represents container health check options in a Dockerfile.

type Port

type Port struct {
	Port      uint16
	Protocol  string
	RawString string
	// contains filtered or unexported fields
}

Port represents an exposed port in a Dockerfile.

func (*Port) String

func (p *Port) String() string

String implements the fmt.Stringer interface.