stack

Documentation

Index

• Constants
• type Container
• type Link
• type Port
• type Service
• type Stack
  • func Read(name, path string) (*Stack, error)

Constants

const (
	//HTTP protocol
	HTTP = "http"
	//TCP protocol
	TCP = "tcp"
	//UDP protocol
	UDP = "udp"
)

Types

type Container

type Container struct {
	Name  string
	Image string
}

Container represents a container in a i2kit.yml file

type Link

type Link struct {
	Service string
	Alias   string
}

Link represents a container link

type Port

type Port struct {
	Container string
	Number    int
	Protocol  string
}

Port represents a container port

type Service

type Service struct {
	Name       string
	Size       string
	Min        int
	Max        int
	Ports      []*Port
	Links      []*Link
	Containers map[string]*Container
}

Service represents a service in a i2kit.yml file

type Stack

type Stack struct {
	Name     string
	Services map[string]*Service
}

Stack represents a i2kit.yml file

func Read

func Read(name, path string) (*Stack, error)

Read returns a stack structure given a path to i2kit.yml file