types

Documentation

Overview

Package types implements type functionality.

Index

• type ContainerCmd
  • func (c *ContainerCmd) Run(ctx context.Context) error
  • func (c *ContainerCmd) SetEnv(env ...string)
  • func (c *ContainerCmd) SetStderr(w io.Writer)
  • func (c *ContainerCmd) SetStdin(r io.Reader)
  • func (c *ContainerCmd) SetStdout(w io.Writer)
• type ContainerCmder
  • func GetContainerCmder(containerNameOrID string) *ContainerCmder
  • func (c *ContainerCmder) Command(command string, args ...string) *ContainerCmd
• type Node
  • func NewNode(name, image, role string) *Node
  • func (n *Node) Delete(ctx context.Context) error
  • func (n *Node) IP(ctx context.Context) (ipv4 string, err error)
  • func (n *Node) IsRunning() bool
  • func (n *Node) Kill(ctx context.Context, signal string) error
  • func (n *Node) Role() (string, error)
  • func (n Node) String() string
  • func (n *Node) WithStatus(status string) *Node
  • func (n *Node) WriteFile(ctx context.Context, dest, content string) error

Types

type ContainerCmd

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

ContainerCmd implements exec.Cmd for docker containers.

func (*ContainerCmd) Run

func (c *ContainerCmd) Run(ctx context.Context) error

Run will run a configured ContainerCmd inside a container instance.

func (*ContainerCmd) SetEnv

func (c *ContainerCmd) SetEnv(env ...string)

SetEnv sets environment variable settings to define in a node.

func (*ContainerCmd) SetStderr

func (c *ContainerCmd) SetStderr(w io.Writer)

SetStderr sets the io.Writer to use for stderr output.

func (*ContainerCmd) SetStdin

func (c *ContainerCmd) SetStdin(r io.Reader)

SetStdin sets the io.Reader to use for receiving stdin input.

func (*ContainerCmd) SetStdout

func (c *ContainerCmd) SetStdout(w io.Writer)

SetStdout sets the io.Writer to use for stdout output.

type ContainerCmder

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

ContainerCmder is used for running commands within a container.

func GetContainerCmder

func GetContainerCmder(containerNameOrID string) *ContainerCmder

GetContainerCmder gets a new ContainerCmder instance used for running commands within a container.

func (*ContainerCmder) Command

func (c *ContainerCmder) Command(command string, args ...string) *ContainerCmd

Command is the command to be run in a container.

type Node

type Node struct {
	Name        string
	ClusterRole string
	InternalIP  string
	Image       string

	Commander *ContainerCmder
	// contains filtered or unexported fields
}

Node can be thought of as a logical component of Kubernetes. A node is either a control plane node, a worker node, or a load balancer node.

func NewNode

func NewNode(name, image, role string) *Node

NewNode returns a Node with defaults.

func (*Node) Delete

func (n *Node) Delete(ctx context.Context) error

Delete removes the container.

func (*Node) IP

func (n *Node) IP(ctx context.Context) (ipv4 string, err error)

IP gets the docker ipv4 of the node.

func (*Node) IsRunning

func (n *Node) IsRunning() bool

IsRunning returns if the container is running.

func (*Node) Kill

func (n *Node) Kill(ctx context.Context, signal string) error

Kill sends the named signal to the container.

func (*Node) Role

func (n *Node) Role() (string, error)

Role returns the role of the node.

func (Node) String

func (n Node) String() string

String returns the name of the node.

func (*Node) WithStatus

func (n *Node) WithStatus(status string) *Node

WithStatus sets the status of the container and returns the node.

func (*Node) WriteFile

func (n *Node) WriteFile(ctx context.Context, dest, content string) error

WriteFile puts a file inside a running container.