compose

Documentation

Index

• func FindComposeFile(dir string) (string, error)
• type Port
• type Project
  • func Parse(path string) (Project, error)
  • func ParseBytes(data []byte) (Project, error)
• type Service

Functions

func FindComposeFile

func FindComposeFile(dir string) (string, error)

FindComposeFile returns the path of the first compose file found in dir.

Types

type Port

type Port struct {
	Host      uint16
	Container uint16
}

Port represents a parsed port mapping from a compose file.

type Project

type Project struct {
	Name     string
	Services []Service
}

Project represents a parsed compose project.

func Parse

func Parse(path string) (Project, error)

Parse reads a compose file and returns a Project.

func ParseBytes

func ParseBytes(data []byte) (Project, error)

ParseBytes parses compose YAML from raw bytes.

type Service

type Service struct {
	Name  string
	Image string
	Ports []Port
}

Service represents a single service parsed from a compose file.