dockercompose

Documentation

Index

• type ComposeFile
  • func New(file string) ComposeFile
  • func Read(file string) ComposeFile
  • func (composeFile *ComposeFile) AddService(name string) *Service
  • func (composeFile *ComposeFile) Read()
  • func (composeFile *ComposeFile) Write() error
  • func (composeFile *ComposeFile) Yaml() ([]byte, error)
• type DockerCompose
  • func (dc *DockerCompose) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Port
• type Service

Types

type ComposeFile

type ComposeFile struct {
	File string
	Data DockerCompose
}

ComposeFile represents a docker-compose.yml file that can be manipulated

func New

func New(file string) ComposeFile

New returns an initialized compose file

func Read

func Read(file string) ComposeFile

Read loads a docker-compose.yml file

func (*ComposeFile) AddService

func (composeFile *ComposeFile) AddService(name string) *Service

AddService adds a service to a compose file

func (*ComposeFile) Read

func (composeFile *ComposeFile) Read()

Read reads the data structure from the file note that all variable interpolations are fully rendered

func (*ComposeFile) Write

func (composeFile *ComposeFile) Write() error

Write writes the data to a file

func (*ComposeFile) Yaml

func (composeFile *ComposeFile) Yaml() ([]byte, error)

Yaml returns the yaml for this compose file

type DockerCompose

type DockerCompose struct {
	Version  string              `yaml:"version"`
	Services map[string]*Service `yaml:"services"`
}

DockerCompose represents a docker-compose.yml file

func (*DockerCompose) UnmarshalYAML

func (dc *DockerCompose) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML is a custom unmarshaller to support different versions of docker compose

type Port

type Port struct {
	Published int64 `yaml:"published"`
	Target    int64 `yaml:"target"`
}

Port represents a port long syntax introduced in v3.2

type Service

type Service struct {
	Image       string            `yaml:"image,omitempty"`
	Ports       []Port            `yaml:"ports,omitempty"`
	Environment map[string]string `yaml:"environment,omitempty"`
	Secrets     map[string]string `yaml:"x-fargate-secrets,omitempty"`
	Labels      map[string]string `yaml:"labels,omitempty"`
}

Service represents a docker container