syphon

Documentation

Overview

Package syphon : Cluster command execution

The syphon sub-system runs inside each container, generally as PID 1 and its purpose is to wait for events to be assigned to it off the Queue.

It does this by periodically polling the flow server it knows about and being assigned a command as part of that polling process.

Once assigned, a command may either run forever, or run up until MAXTIMEOUT has been reached, usually 15 minutes after the command first began executing, after which the command will terminate and the container will begin polling again for the next command.

Index

• type Syphon
  • func NewSyphon() *Syphon
  • func (syphon *Syphon) Init()
  • func (syphon *Syphon) Run() int

Types

type Syphon

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

Syphon is the command executor embedded inside docker containers

func NewSyphon

func NewSyphon() *Syphon

NewSyphon : Create a new syphon executor

func (*Syphon) Init

func (syphon *Syphon) Init()

Init : Syphon will not have an initialiser as it contains no flags to parse

func (*Syphon) Run

func (syphon *Syphon) Run() int

Run : Runs the syphon command executor

This is the main entry point for the syphon command and is executed from command.Command package.

When triggered, syphon will register against the flow server once every 10 seconds. If the registration returns a command, syphon will then register itself as busy, execute the returned command and return the output of the command back to the flow server on completion.