node

Documentation

Index

• func Stop(nodes []*Node) error
• type Environment
  • func NewEnvironment() (*Environment, error)
  • func (env *Environment) Stop() error
• type Node
  • func New(image string, Environment *Environment, opts ...Option) ([]*Node, error)
  • func (n *Node) Address() string
  • func (n *Node) Logs() (chan string, chan error)
• type Option
  • func WithCommand(command []string) Option
  • func WithCount(count int) Option
  • func WithEnv(env []string) Option
  • func WithName(name string) Option
  • func WithPortMapping(containerPort, nodePort int) Option
• type Options

Functions

func Stop

func Stop(nodes []*Node) error

Types

type Environment

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

func NewEnvironment

func NewEnvironment() (*Environment, error)

func (*Environment) Stop

func (env *Environment) Stop() error

type Node

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

func New

func New(
	image string,
	Environment *Environment,
	opts ...Option,
) ([]*Node, error)

func (*Node) Address

func (n *Node) Address() string

Address returns the node's address

func (*Node) Logs

func (n *Node) Logs() (chan string, chan error)

Logs filters the node json logs for the specific tag

type Option

type Option func(*Options)

func WithCommand

func WithCommand(command []string) Option

func WithCount

func WithCount(count int) Option

func WithEnv

func WithEnv(env []string) Option

func WithName

func WithName(name string) Option

func WithPortMapping

func WithPortMapping(containerPort, nodePort int) Option

type Options

type Options struct {
	Name         string
	Count        int
	Env          []string
	Command      []string
	PortMappings map[int]int
}