common

Documentation

Overview

Package common contains the utilities and the types common to the checkers

Index

• func FormatStatus(moduleStatus ModuleStatus) string
• func GetModuleAlerts(module liqov1beta1.Module) []string
• type ModuleStatus
  • func CheckModuleStatus(module liqov1beta1.Module) ModuleStatus
  • func CheckModuleStatusAndAlerts(module liqov1beta1.Module) (status ModuleStatus, alerts []string)

Functions

func FormatStatus

func FormatStatus(moduleStatus ModuleStatus) string

FormatStatus returns a formatted string with the provided status.

func GetModuleAlerts

func GetModuleAlerts(module liqov1beta1.Module) []string

GetModuleAlerts returns the alerts for the given module.

Types

type ModuleStatus

type ModuleStatus string

ModuleStatus represents the status of each of the modules.

const (
	// ModuleHealthy indicates a module that works as expected.
	ModuleHealthy ModuleStatus = "Healthy"
	// ModuleUnhealthy indicates that there are issues with the module.
	ModuleUnhealthy ModuleStatus = "Unhealthy"
	// ModuleDisabled indicates that the modules is not currently used.
	ModuleDisabled ModuleStatus = "Disabled"
)

func CheckModuleStatus

func CheckModuleStatus(module liqov1beta1.Module) ModuleStatus

CheckModuleStatus based on the conditions of a module returns its status.

func CheckModuleStatusAndAlerts

func CheckModuleStatusAndAlerts(module liqov1beta1.Module) (status ModuleStatus, alerts []string)

CheckModuleStatusAndAlerts returns the status and the alerts of the given module.