links

Documentation

Index

• type Link
  • func NewLink(parentIP, childIP, name string, env []string, ...) *Link
  • func (l *Link) ToEnv() []string

Types

type Link

type Link struct {
	// Parent container IP address
	ParentIP string
	// Child container IP address
	ChildIP string
	// Link name
	Name string
	// Child environments variables
	ChildEnvironment []string
	// Child exposed ports
	Ports []nat.Port
}

Link struct holds informations about parent/child linked container

func NewLink

func NewLink(parentIP, childIP, name string, env []string, exposedPorts map[nat.Port]struct{}) *Link

NewLink initializes a new Link struct with the provided options.

func (*Link) ToEnv

func (l *Link) ToEnv() []string

ToEnv creates a string's slice containing child container informations in the form of environment variables which will be later exported on container startup.