preflight

Documentation

Index

• Constants
• Variables
• func RunDeployPreflightCheck(opts DeployPreflightCheckOptions) (string, error)
• type Check
  • func CLIInBin() Check
  • func ConnectivityCheck(urls []string) Check
  • func DefaultConnectivityCheck() Check
  • func DefaultKernelVersionCheck() Check
  • func DefaultMinimumDiskCheck(c *dc.AutomateConfig) Check
  • func DefaultMinimumRAMCheck() Check
  • func DefaultPortCheck(skipShared bool, config *dc.AutomateConfig) (Check, error)
  • func DefaultSysctlCheck() Check
  • func HasCmdCheck(cmdName string) Check
  • func HasNobodyCheck() Check
  • func HasUserCheck(username string) Check
  • func HasUseraddCheck() Check
  • func IsA2DeployedCheck(portCheck *Check) Check
  • func IsSystemdCheck() Check
  • func KernelVersionCheck(minimumVersion proc.KernelVersion) Check
  • func MinimumDiskCheck(minimumBytes uint64) Check
  • func MinimumRAMCheck(kiloBytesMinimum int) Check
  • func PortCheck(portsToCheck []int) Check
  • func RootUserRequiredCheck() Check
• type ConsoleReporter
  • func NewConsoleReporter() *ConsoleReporter
  • func (r *ConsoleReporter) HasFailures() bool
  • func (c *ConsoleReporter) PrintSummaries()
  • func (r *ConsoleReporter) ReportFailure(msg string)
  • func (*ConsoleReporter) ReportSuccess(msg string)
  • func (r *ConsoleReporter) ReportSummary(msg string)
• type DeployPreflightCheckOptions
• type DeployPreflightChecker
  • func NewDeployPreflightChecker(opts DeployPreflightCheckOptions) *DeployPreflightChecker
  • func (c *DeployPreflightChecker) Run(probe TestProbe) error
• type InMemoryPrintReporter
  • func NewInMemoryPrintReporter() *InMemoryPrintReporter
  • func (r *InMemoryPrintReporter) HasFailures() bool
  • func (r *InMemoryPrintReporter) Out() string
  • func (r *InMemoryPrintReporter) ReportFailure(msg string)
  • func (r *InMemoryPrintReporter) ReportSuccess(msg string)
  • func (r *InMemoryPrintReporter) ReportSummary(msg string)
• type Reporter
• type SysctlCheck
  • func (s SysctlCheck) IsRange() bool
  • func (s SysctlCheck) IsValid(val uint64) bool
  • func (s SysctlCheck) SysctlString() string
• type TCPInfo
• type TCPState
  • func (tcpState TCPState) String() string
• type TestProbe
  • func NewTestProbe(r Reporter) TestProbe

Constants

const GB = 1 << 30

Variables

var TCPState_name = map[TCPState]string{
	TCPStateEstablished: "ESTABLISHED",
	TCPStateSynSent:     "SYN_SENT",
	TCPStateSynRecv:     "SYN_RECV",
	TCPStateFinWait1:    "FIN_WAIT1",
	TCPStateFinWait2:    "FIN_WAIT2",
	TCPStateTimeWait:    "TIME_WAIT",
	TCPStateClose:       "CLOSE",
	TCPStateCloseWait:   "CLOSE_WAIT",
	TCPStateLastAck:     "LAST_ACK",
	TCPStateListen:      "LISTEN",
	TCPStateClosing:     "CLOSING",
	TCPStateUnknown:     "UNKNOWN",
}

Functions

func RunDeployPreflightCheck

func RunDeployPreflightCheck(opts DeployPreflightCheckOptions) (string, error)

RunDeployPreflightCheck runs the Deploy preflight checks

Types

type Check

type Check struct {
	Name        string
	Description string
	TestFunc    func(TestProbe) error
}

func CLIInBin

func CLIInBin() Check

func ConnectivityCheck

func ConnectivityCheck(urls []string) Check

func DefaultConnectivityCheck

func DefaultConnectivityCheck() Check

func DefaultKernelVersionCheck

func DefaultKernelVersionCheck() Check

func DefaultMinimumDiskCheck

func DefaultMinimumDiskCheck(c *dc.AutomateConfig) Check

func DefaultMinimumRAMCheck

func DefaultMinimumRAMCheck() Check

func DefaultPortCheck

func DefaultPortCheck(skipShared bool, config *dc.AutomateConfig) (Check, error)

func DefaultSysctlCheck

func DefaultSysctlCheck() Check

func HasCmdCheck

func HasCmdCheck(cmdName string) Check

func HasNobodyCheck

func HasNobodyCheck() Check

func HasUserCheck

func HasUserCheck(username string) Check

func HasUseraddCheck

func HasUseraddCheck() Check

func IsA2DeployedCheck

func IsA2DeployedCheck(portCheck *Check) Check

func IsSystemdCheck

func IsSystemdCheck() Check

func KernelVersionCheck

func KernelVersionCheck(minimumVersion proc.KernelVersion) Check

func MinimumDiskCheck

func MinimumDiskCheck(minimumBytes uint64) Check

func MinimumRAMCheck

func MinimumRAMCheck(kiloBytesMinimum int) Check

func PortCheck

func PortCheck(portsToCheck []int) Check

func RootUserRequiredCheck

func RootUserRequiredCheck() Check

type ConsoleReporter

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

func NewConsoleReporter

func NewConsoleReporter() *ConsoleReporter

func (*ConsoleReporter) HasFailures

func (r *ConsoleReporter) HasFailures() bool

func (*ConsoleReporter) PrintSummaries

func (c *ConsoleReporter) PrintSummaries()

func (*ConsoleReporter) ReportFailure

func (r *ConsoleReporter) ReportFailure(msg string)

func (*ConsoleReporter) ReportSuccess

func (*ConsoleReporter) ReportSuccess(msg string)

func (*ConsoleReporter) ReportSummary

func (r *ConsoleReporter) ReportSummary(msg string)

type DeployPreflightCheckOptions

type DeployPreflightCheckOptions struct {
	SkipSharedPortCheck bool
	SkipA2DeployedCheck bool
	Airgap              bool
	AutomateConfig      *dc.AutomateConfig
}

type DeployPreflightChecker

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

func NewDeployPreflightChecker

func NewDeployPreflightChecker(opts DeployPreflightCheckOptions) *DeployPreflightChecker

func (*DeployPreflightChecker) Run

func (c *DeployPreflightChecker) Run(probe TestProbe) error

type InMemoryPrintReporter

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

func NewInMemoryPrintReporter

func NewInMemoryPrintReporter() *InMemoryPrintReporter

func (*InMemoryPrintReporter) HasFailures

func (r *InMemoryPrintReporter) HasFailures() bool

func (*InMemoryPrintReporter) Out

func (r *InMemoryPrintReporter) Out() string

func (*InMemoryPrintReporter) ReportFailure

func (r *InMemoryPrintReporter) ReportFailure(msg string)

func (*InMemoryPrintReporter) ReportSuccess

func (r *InMemoryPrintReporter) ReportSuccess(msg string)

func (*InMemoryPrintReporter) ReportSummary

func (r *InMemoryPrintReporter) ReportSummary(msg string)

type Reporter

type Reporter interface {
	ReportSuccess(string)
	ReportFailure(string)
	ReportSummary(string)
}

type SysctlCheck

type SysctlCheck struct {
	Name       string
	RangeLower uint64
	RangeUpper uint64
	FixValue   uint64
}

func (SysctlCheck) IsRange

func (s SysctlCheck) IsRange() bool

func (SysctlCheck) IsValid

func (s SysctlCheck) IsValid(val uint64) bool

func (SysctlCheck) SysctlString

func (s SysctlCheck) SysctlString() string

type TCPInfo

type TCPInfo struct {
	LocalIP   net.IP
	LocalPort int
	State     TCPState
}

type TCPState

type TCPState int

const (
	TCPStateEstablished TCPState = 1
	TCPStateSynSent     TCPState = 2
	TCPStateSynRecv     TCPState = 3
	TCPStateFinWait1    TCPState = 4
	TCPStateFinWait2    TCPState = 5
	TCPStateTimeWait    TCPState = 6
	TCPStateClose       TCPState = 7
	TCPStateCloseWait   TCPState = 8
	TCPStateLastAck     TCPState = 9
	TCPStateListen      TCPState = 10
	TCPStateClosing     TCPState = 11
	TCPStateUnknown     TCPState = 12
)

func (TCPState) String

func (tcpState TCPState) String() string

type TestProbe

type TestProbe interface {
	Reporter
	File(filePath string) ([]byte, error)
	IsSymlink(filePath string) (bool, error)
	Euid() int
	AvailableDiskSpace(path string) (uint64, error)
	LookupUser(username string) (*user.User, error)
	LookPath(file string) (string, error)
	HTTPConnectivity(url string) error
}

func NewTestProbe

func NewTestProbe(r Reporter) TestProbe