checks

Documentation

Index

• type Cpu
  • func (*Cpu) Describe() string
  • func (cpu *Cpu) Run(_context *check.RunContext) <-chan []check.Result
• type Docker
  • func (*Docker) Describe() string
  • func (*Docker) Run(context *check.RunContext) <-chan []check.Result
• type DockerInfo
• type Follower
  • func (*Follower) Describe() string
  • func (follower *Follower) Run(context *check.RunContext) <-chan []check.Result
• type Host
  • func (*Host) Describe() string
  • func (*Host) Run(context *check.RunContext) <-chan []check.Result
• type LeaderPort
• type Memory
  • func (*Memory) Describe() string
  • func (memory *Memory) Run(context *check.RunContext) <-chan []check.Result
• type Podman
  • func (*Podman) Describe() string
  • func (podman *Podman) Run(context *check.RunContext) <-chan []check.Result
• type PodmanInfo
• type StoreInfo
• type VersionInfo

Types

type Cpu

type Cpu struct {
}

Cpu collects inspection information on the host machines CPU cores and architecture

func (*Cpu) Describe

func (*Cpu) Describe() string

Describe provides a textual description of the info this check gathers

func (*Cpu) Run

func (cpu *Cpu) Run(_context *check.RunContext) <-chan []check.Result

Run executes the CPU inspection checks

type Docker

type Docker struct{}

Docker collects the information on the version of Docker on the system

func (*Docker) Describe

func (*Docker) Describe() string

Describe provides a textual description of what this check gathers info on

func (*Docker) Run

func (*Docker) Run(context *check.RunContext) <-chan []check.Result

Run performs the Docker inspection checks

type DockerInfo

type DockerInfo struct {
	ServerErrors  []string `json:"ServerErrors"`
	ServerVersion string   `json:"ServerVersion"`
	Driver        string   `json:"Driver"`
	DockerRootDir string   `json:"DockerRootDir"`
}

DockerInfo contains the key fields from the `docker info` output

type Follower

type Follower struct {
}

Follower implements a inspection check for the FOLLOWER environment variable.

func (*Follower) Describe

func (*Follower) Describe() string

Describe provides a textual description of what this check gathers info on

func (*Follower) Run

func (follower *Follower) Run(context *check.RunContext) <-chan []check.Result

Run executes the check

type Host

type Host struct{}

Host collects inspection information on the host machine's metadata, such as the operating system

func (*Host) Describe

func (*Host) Describe() string

Describe provides a textual description of what this check gathers

func (*Host) Run

func (*Host) Run(context *check.RunContext) <-chan []check.Result

Run executes the Host inspection checks

type LeaderPort

type LeaderPort struct {
	PortName string
	Port     string
	IsOpen   bool
}

LeaderPort is the port that the follower listens on

type Memory

type Memory struct{}

Memory collects inspection information on the host machine's memory availability and usage

func (*Memory) Describe

func (*Memory) Describe() string

Describe provides a textual description of what this check gathers info on

func (*Memory) Run

func (memory *Memory) Run(context *check.RunContext) <-chan []check.Result

Run executes the Memory inspection checks

type Podman

type Podman struct{}

Podman collects the information on the version of Podman on the system

func (*Podman) Describe

func (*Podman) Describe() string

Describe provides a textual description of what this check gathers info on

func (*Podman) Run

func (podman *Podman) Run(context *check.RunContext) <-chan []check.Result

Run performs the Podman inspection checks

type PodmanInfo

type PodmanInfo struct {
	Version VersionInfo `json:"version"`
	Store   StoreInfo   `json:"store"`
}

PodmanInfo contains the key fields from the `podman info` output

type StoreInfo

type StoreInfo struct {
	GraphDriverName string `json:"graphDriverName"`
	GraphRoot       string `json:"graphRoot"`
	RunRoot         string `json:"runRoot"`
	VolumePath      string `json:"volumePath"`
}

StoreInfo contains the Podman storage information

type VersionInfo

type VersionInfo struct {
	Version string
}

VersionInfo contains the Podman version information