healthchecks

Documentation

Index

• func PerformChecks(sshContext *ssh.SSHContext, checkName string, host Host, ...) (err error)
• func PerformHealthChecks(sshContext *ssh.SSHContext, host Host, timeout int) (err error)
• func PerformPreDeployChecks(sshContext *ssh.SSHContext, host Host, timeout int) (err error)
• type CmdHealthCheck
  • func (healthCheck CmdHealthCheck) GetDescription() string
  • func (healthCheck CmdHealthCheck) GetPeriod() int
  • func (healthCheck CmdHealthCheck) Run(host Host) error
• type HealthCheck
• type HealthChecks
• type Host
• type HttpHealthCheck
  • func (healthCheck HttpHealthCheck) GetDescription() string
  • func (healthCheck HttpHealthCheck) GetPeriod() int
  • func (healthCheck HttpHealthCheck) Run(host Host) error

Functions

func PerformChecks

func PerformChecks(sshContext *ssh.SSHContext, checkName string, host Host, healthChecks HealthChecks, timeout int) (err error)

func PerformHealthChecks

func PerformHealthChecks(sshContext *ssh.SSHContext, host Host, timeout int) (err error)

func PerformPreDeployChecks

func PerformPreDeployChecks(sshContext *ssh.SSHContext, host Host, timeout int) (err error)

Types

type CmdHealthCheck

type CmdHealthCheck struct {
	SshContext  *ssh.SSHContext
	Description string
	Cmd         []string
	Period      int
	Timeout     int
}

func (CmdHealthCheck) GetDescription

func (healthCheck CmdHealthCheck) GetDescription() string

func (CmdHealthCheck) GetPeriod

func (healthCheck CmdHealthCheck) GetPeriod() int

func (CmdHealthCheck) Run

func (healthCheck CmdHealthCheck) Run(host Host) error

type HealthCheck

type HealthCheck interface {
	GetDescription() string
	GetPeriod() int
	Run(Host) error
}

type HealthChecks

type HealthChecks struct {
	Http []HttpHealthCheck
	Cmd  []CmdHealthCheck
}

type Host

type Host interface {
	GetName() string
	GetTargetHost() string
	GetTargetPort() int
	GetTargetUser() string
	GetHealthChecks() HealthChecks
	GetPreDeployChecks() HealthChecks
}

type HttpHealthCheck

type HttpHealthCheck struct {
	Description string
	Headers     map[string]string
	Host        *string
	InsecureSSL bool
	Path        string
	Port        int
	Scheme      string
	Period      int
	Timeout     int
}

func (HttpHealthCheck) GetDescription

func (healthCheck HttpHealthCheck) GetDescription() string

func (HttpHealthCheck) GetPeriod

func (healthCheck HttpHealthCheck) GetPeriod() int

func (HttpHealthCheck) Run

func (healthCheck HttpHealthCheck) Run(host Host) error